docs(claude-md): credit each changelog entry to its pull request and author - #2941
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Release notes are built from
CHANGELOG.md, and they credited nobody. GitHub's own generated notes end every line withby @author in #123. This gives every released entry the same credit, in the parens it already ends with:Why the release adds it, not the pull request
A pull request has no number until it is opened, so an entry written with the change cannot carry one, and a contributor should not need a second commit to add it.
scripts/ci/changelog_credits.pystamps it at release time from the history:git blamenames the commit that wrote each entry line.gh pr viewnames that pull request's author, the person credited, not whoever merged it.It folds the credit into an existing issue reference (
(#1748)becomes(#1748, #2741 by @J2TeamNNL)), never repeats a number that is already there, and never touches an entry that is already credited. An entry whose commit has no pull request number, or that is not committed yet, is left bare and listed so the release can credit it by hand.Dry run against
[Unreleased]as it stands: 236 entries credited across 81 pull requests, none left bare. The three contributors' entries (@J2TeamNNL#2741,@digows#2905,@filipac#2927) land on their own lines. Blame credits the last commit to touch a line, so a maintainer rewording a contributor's entry later would take the credit; each contributor PR's lines were checked against their current blame and none had been.What changed
scripts/ci/changelog_credits.pyandtest_changelog_credits.py(15 cases), run in Repo Hygiene next to the release note tests.